/*
Copyright (c) 2009, Young Digital Planet SA
All rights reserved.

* Redistribution and use in source and binary forms, with or without 
  modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this 
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, 
  this list of conditions and the following disclaimer in the documentation 
  and/or other materials provided with the distribution.
* Neither the name of the Young Digital Planet SA nor the names of its 
  contributors may be used to endorse or promote products derived from this 
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
package com.yauthor.module.editor.services
{
	import flash.display.DisplayObject;
	import flash.events.IEventDispatcher;
	import flash.net.FileFilter;
	
	/**
	 * Dispatched when user selects asset from the list
	 */ 
	[Event(name="assetsBrowserOnSelect", type="com.yauthor.module.editor.events.AssetsBrowserEvent")]
	
	/**
	 * Dispatched when browsing is canceled by user.   
	 */
	[Event(name="assetsBrowserOnCancel", type="com.yauthor.module.editor.events.AssetsBrowserEvent")]

	/**
	 * Interface of the asset browse/upload service.
	 * Implementation of the 'IAssetsBrowser' provides native FileFilter definitions. Usege of these
	 * filters is recomended when calling browse() method   ( AssetsBrowser provides filters with a proper 
	 * translation if editor works in a diferent language version )
	 * 
	 * @example The following code reads path to selected asset 

<listing version="3.0">
	var assetBrowser:IAssetsBrowser = IEditorEnvironment( env ).getService( IAssetsBrowser );
	assetBrowser.browse();
	assetBrowser.addEventListener( AssetsBrowserEvent.SELECT, function (e:AssetsBrowserEvent):void{
			trace ("asset path" + e.assetInfo.path ); 
	} );

</listing>
	 */ 
	
	
	
	public interface IAssetsBrowser extends IEventDispatcher
	{
		/**
		 * Start browse assets dialog.
		 * @param fileFilter instance of a flash.net.FileFilter class. If not set, 'all files' filter will be applied. 
		 * @param environment instance of IEditorEnvironment from the editor that requests the service 
		 */ 
		 
		function browse( fileFilter:FileFilter = null ):void;
		
		/**
		 * @return native image FileFilter  
		 */
		function get imageFileFilter():FileFilter;
		
		/**
		 * @return native movie FileFilter  
		 */
		function get movieFileFilter():FileFilter;
		
		/**
		 * @return native sound FileFilter  
		 */
		function get soundFileFilter():FileFilter;
		
		/**
		 * @return native documents FileFilter. Contains following extensions .pdf .doc and .xls 
		 */
		function get documentFileFilter ():FileFilter;
		
		/**
		 * @return native 'all' FileFilter  
		 */
		function get allFileFilter():FileFilter;
		
		/**
		 * Sets module editor popup parent
		 * @param parent for module selector popup window
		 */  
		function set moduleEditorParent(p:DisplayObject):void;
		
		/**
		 * Property allows to force selection of an asset in AssetBrowser window
		 * Path should be set as relative to edited page file. 
		 * @param path relative path to the asseet
		 */  
		function set selectedAssetPath(path:String):void;
		
		/**
		 * @return relative path to the currently selected asseet
		 */
		function get selectedAssetPath():String;
		
	}
}